API Documentation
Public Member Functions | Static Public Member Functions | List of all members
nkWinUi::Popup Class Reference

A graphical popup window. More...

Inheritance diagram for nkWinUi::Popup:
nkWinUi::Window nkWinUi::Component nkExport::Exportable

Public Member Functions

 Popup ()
 
 ~Popup ()
 
virtual void setParentComponent (Component *parent, bool makeItVisible=true) override
 
virtual void pop ()
 
virtual void unpop ()
 
- Public Member Functions inherited from nkWinUi::Window
 Window ()
 
 ~Window ()
 
MenuBargetMenuBar () const
 
virtual MenuBarattachMenuBar ()
 
virtual void maximize (bool val)=0
 
virtual void exportIntrospection (nkExport::Node *rootNode) override
 
virtual void importClassFromTree (nkExport::Node *rootNode) override
 
- Public Member Functions inherited from nkWinUi::Component
 Component ()
 
virtual ~Component ()
 
LayoutgetLayout () const
 
nkMaths::Point getPositionInParent () const
 
nkMaths::Point getPositionInScreen () const
 
int getWidth () const
 
int getHeight () const
 
nkMaths::Rectangle getArea () const
 
virtual nkMaths::Point getBorderExtents () const
 
virtual int getLayoutAllowedWidth () const
 
virtual int getLayoutAllowedHeight () const
 
virtual int getLayoutAllowedOffsetX () const
 
virtual int getLayoutAllowedOffsetY () const
 
bool isInitialized () const
 
ComponentgetParentComponent () const
 
COMPONENT_TYPE getComponentType () const
 
const char * getComponentName () const
 
bool getVisibility () const
 
virtual const char * getLabel () const
 
void * getData () const
 
bool isEnabled () const
 
bool isForegroundWindow () const
 
unsigned int getZDepth () const
 
bool getVisibleOnLoad () const
 
virtual LayoutsetLayout (LAYOUT_TYPE layoutType)
 
virtual void setPositionInParent (nkMaths::Point position)
 
virtual void setPositionInScreen (nkMaths::Point position)
 
virtual void setSize (int width, int height)
 
virtual void setWidth (int width)
 
virtual void setHeight (int height)
 
void setMinSize (unsigned int width, unsigned int height)
 
void setMaxSize (unsigned int width, unsigned int height)
 
void setRatio (float widthOverHeight)
 
virtual void setArea (nkMaths::Rectangle area)
 
virtual void setLabel (const std::string_view &label)
 
void setComponentName (const std::string_view &name)
 
virtual void setVisibility (bool value)
 
void setData (void *data)
 
void setEnabled (bool value)
 
void setVisibleOnLoad (bool value)
 
void addChild (Component *child, bool makeItVisible=true)
 
void removeChild (Component *child)
 
void removeChild (unsigned int index)
 
ComponentgetChild (unsigned int index)
 
unsigned int getChildIndex (Component *child)
 
void unloadWithChildren ()
 
void loadWithChildren ()
 
void updateZDepth ()
 
void bringToForeground ()
 
void focusWindow ()
 
nkMaths::Point getCoordRelativeFromAbsolute (const nkMaths::Point &absCoords)
 
nkMaths::Point getCoordAbsoluteFromRelative (const nkMaths::Point &relCoords)
 
virtual void load ()=0
 
virtual void unload ()=0
 
virtual void updateWindow ()
 
nkImages::Image paintToImage ()
 
void onSized ()
 
ContextMenucreateContextMenu ()
 
ContextMenugetCurrentContextMenu ()
 
void shutContextMenu ()
 
virtual void exportClassToTree (nkExport::Node *rootNode) override
 
- Public Member Functions inherited from nkExport::Exportable
 Exportable ()
 
virtual ~Exportable ()
 

Static Public Member Functions

static POPUP_RESULT pop (POPUP_TYPE type, const char *title, const char *message, Component *parent)
 

Detailed Description

A graphical popup window.

Constructor & Destructor Documentation

◆ Popup()

nkWinUi::Popup::Popup ( )

Constructor.

◆ ~Popup()

nkWinUi::Popup::~Popup ( )

Destructor.

Member Function Documentation

◆ setParentComponent()

virtual void nkWinUi::Popup::setParentComponent ( Component parent,
bool  makeItVisible = true 
)
overridevirtual

◆ pop() [1/2]

virtual void nkWinUi::Popup::pop ( )
virtual

Pops the window on the screen.

◆ unpop()

virtual void nkWinUi::Popup::unpop ( )
virtual

Hides the window.

◆ pop() [2/2]

static POPUP_RESULT nkWinUi::Popup::pop ( POPUP_TYPE  type,
const char *  title,
const char *  message,
Component parent 
)
static

Static version to have a temporary popup pops on screen.

Parameters
typeThe popup type to use.
titleThe title the window should have.
messageThe message to write.
parentThe parent component once the popup depops.
Returns
The result describing what the user selected.

The documentation for this class was generated from the following file: